---
title: Uniscript
icon: Terminal
---

<MetaData
  lang="zh-CN"
  meta={{
    plugins: [{
      client: '@univerjs/uniscript',
      locale: '@univerjs/uniscript/locale/zh-CN',
      style: '@univerjs/uniscript/lib/index.css',
    }],
    server: '否',
  }}
/>

Uniscript 提供了在线快速添加或编辑 Facade API 的能力。安装之后，工具栏会出现一个新的按钮，点击后会弹出一个侧边栏，可以在其中输入代码并执行。我们文档中任何 univerAPI 开头的代码均可在此处执行。

<Callout title="友情提示">
  Uniscript 的面板中注入了 Facade API 的实例对象 `univerAPI`，可以直接使用它来调用文档中所提到的 Facade API。
</Callout>

## 预设模式

Uniscript 并未提供预设模式，但支持与其插件混用。

### 安装

```package-install
npm install @univerjs/uniscript
```

### 使用

```typescript
import { UniverUniscriptPlugin } from '@univerjs/uniscript' // [!code ++]

import '@univerjs/uniscript/lib/index.css' // [!code ++]

const { univerAPI } = createUniver({
  locale: LocaleType.ZH_CN,
  locales: {
    [LocaleType.ZH_CN]: mergeLocales(
      UniverPresetDocsCoreZhCN,
      UniscriptZhCN, // [!code ++]
    ),
  },
  presets: [
    UniverDocsCorePreset(),
  ],
  plugins: [
    UniverUniscriptPlugin, // [!code ++]
  ],
})
```

## 插件模式

### 安装

```package-install
npm install @univerjs/uniscript
```

### 使用

```typescript
import { LocaleType, mergeLocales, Univer } from '@univerjs/core'
import { UniverUniscriptPlugin } from '@univerjs/uniscript' // [!code ++]

import '@univerjs/uniscript/lib/index.css' // [!code ++]

const univer = new Univer({
  locale: LocaleType.ZH_CN,
  locales: {
    [LocaleType.ZH_CN]: mergeLocales(
      UniscriptZhCN, // [!code ++]
    ),
  },
})

univer.registerPlugin(UniverUniscriptPlugin) // [!code ++]
```
